Skip to content

docs: add root CLAUDE.md for AI assistants#287

Merged
baoduy merged 1 commit intodevfrom
claude/add-claude-documentation-LgbPS
May 1, 2026
Merged

docs: add root CLAUDE.md for AI assistants#287
baoduy merged 1 commit intodevfrom
claude/add-claude-documentation-LgbPS

Conversation

@baoduy
Copy link
Copy Markdown
Owner

@baoduy baoduy commented May 1, 2026

Summary

  • Add a root-level CLAUDE.md that serves as the primary entry point for Claude Code (and other AI assistants) when they open the repo at the top level. It covers:
    • Repo-at-a-glance: SDK pin, default branch, CI gate.
    • Top-level layout (root vs. src/, docs/, specs/, issues/, .github/).
    • Authoritative context table pointing to src/CLAUDE.md, src/AGENTS.md, the src/memory-bank/ knowledge base, and docs/.
    • Common build/test/format commands (run from src/).
    • Architectural big picture: aggregate roots + events, repos + specifications, dynamic predicate builder with the mandatory .AsExpandable() shape, CQRS via SlimBus, EF Core interceptors, idempotency middleware.
    • Conventions that trip up generated code (test naming, file headers, XML docs, central package management, EF Core best practices).
    • Coverage targets and recurring pitfalls.
  • Fix a stale absolute path (/Users/steven/_CODE/DRUNK/DKNet/src) in the existing src/CLAUDE.md to use a relative src/ reference.

Test plan

  • Verify CLAUDE.md renders correctly on GitHub.
  • Confirm all referenced files (src/AGENTS.md, src/memory-bank/*, docs/*, .github/copilot-instructions.md) exist.
  • Spot-check that the documented commands (dotnet build/test/format, ./nuget.sh pack) match what's in src/.

https://claude.ai/code


Generated by Claude Code

- New root-level CLAUDE.md acts as the primary AI-assistant entry point,
  covering repo layout, authoritative context files, build/test commands,
  architectural overview, conventions, coverage targets, and pitfalls.
- Fix stale absolute path in src/CLAUDE.md (use relative `src/`).
@baoduy baoduy marked this pull request as ready for review May 1, 2026 04:40
@baoduy baoduy merged commit 8fce00b into dev May 1, 2026
1 of 2 checks passed
@baoduy baoduy deleted the claude/add-claude-documentation-LgbPS branch May 1, 2026 04:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants